home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / comm / fido / Rock_1_5.lha / ROCK / Rock.DOC < prev    next >
Text File  |  1995-07-30  |  10KB  |  316 lines
  1.  
  2. **************************************************************************
  3.  
  4.               Rock v1.5 - Fidonet mailer for point systems
  5.                   Copyright (C) 1995  Jean-Marc Xiume'
  6.           This software is distributed under the terms of the
  7.      GNU General Public License. Read "license.doc" for more details.
  8.  
  9.  
  10.      Rock is based upon POP, copyright (c) 1994 Denis Turcotte
  11.      and Robert Williamson.
  12.      Rock.rexx is based upon JAZ.f copyright (c) 1994 Robert Williamson.
  13.      LaunchWPL is copyright (C) 1994 Robert Williamson.
  14.      xferq.library is copyright (c) 1993 David Jones
  15.      and (c) 1994, 1995 Robert Williamson.
  16.      wpl.library is copyright (c) 1993 Russell McOrmond.
  17.  
  18. **************************************************************************
  19.  
  20.  
  21.  
  22. Introduction
  23. ------------
  24.  
  25. Welcome to Rock, one of the smallest Point mailers available for the
  26. Amiga. It's written using the WPL and Arexx languages.
  27.  
  28. Rock is pretty easy to install and to configure, is not memory and disk
  29. space hungry, and allows to call the all the different phone numbers of
  30. your boss if the line is busy.
  31.  
  32. For calls to other systems than the boss, it can make use of the nodelist
  33. if you already have installed the traplist.library, otherwise it asks for
  34. the phone number. (Note that traplist.library is free, but TrapList is a
  35. shareware program).
  36.  
  37.  
  38. To keep things simple, the only available protocols are WAZOO for
  39. negociation and ZEDZAP for file transfer.
  40.  
  41. An example configuration file (ROCK.cfg) and the related doc (RockCfg.doc)
  42. are given.
  43.  
  44.  
  45.  
  46. Installation
  47. ------------
  48.  
  49. Simply copy the ROCK directory where you want, and assign "rock:" to that
  50. directory. You should add a line like the following one in your
  51. user-startup:
  52.  
  53. Assign rock: DH1:Fidonet/Rock
  54.  
  55. The libraries in the distribution's libs directory (wpl.library,
  56. xferq.library, and xprzedzap.library) must be accessible to the system.
  57. You can either copy them in the libs: directory, or add the following
  58. line to your user-startup:
  59.  
  60. Assign libs: rock:libs add
  61.  
  62. To properly unarchive files and preserve file attributes you should use
  63. the -a option of LHA, or manualy set the "s" flag of "rock" and "boss"
  64. with the protect command. ( e.g.: protect rock +s )
  65.  
  66. Before starting to use Rock, you must configure it. Read "RockCfg.doc",
  67. then modify the configuration file "rock.cfg" to suit your needs.
  68.  
  69. If you want, you can use the Fidonet Nodelist in traplist format. The
  70. traplist software must be installed and the traplist.library must be in
  71. the libs: directory.
  72.  
  73.  
  74.  
  75. Usage
  76. -----
  77.  
  78. Amigados template: rock ADDRESS,CONFIG
  79.  
  80. To start a session with your boss, just type "Rock" in the shell, or
  81. click on the BOSS icon (the "s" flag must be set for those files,
  82. see installation).
  83.  
  84. To call another system, give its 4D address as an argument on the
  85. command line (ex: ROCK 1:167/151.0), Rock will then ask for the phone
  86. number and the password for this system.
  87.  
  88. If you use the nodelist (see the nodelist parameter in the configuration
  89. file), rock will try to find these datas there. If it cannot find them,
  90. it will ask to enter manually, like above.
  91.  
  92. You can also give the name of the config file to use as an argument,
  93. for example if you want to poll more than one BBS.
  94. It's a standard amigados template, so if you give a config file name
  95. and no address you have to use the "config" keyword.
  96.  
  97. Examples:
  98.     rock
  99.     rock 2:320/104
  100.     rock 2:320/109 tlcsbbs.cfg
  101.     rock config tlcsbbs.cfg
  102.  
  103.  
  104. You can terminate rock by pressing control-c in its window, except
  105. during the file transfer phase.
  106.  
  107.  
  108.  
  109. Support Scripts
  110. ---------------
  111.  
  112. The "KillRock" script is for... trying to kill Rock if things go wrong.
  113.  
  114.  
  115. The "WaitRock.rexx" script waits for rock to terminate. It can be used,
  116. for example, in an amigados script like this:
  117.   ...
  118.   rock:rock             ;start rock
  119.   wait 3                ;allow it some time to declare its arexx port
  120.   rx rock:waitrock.rexx ;wait until the end of the session
  121.   ...
  122. This scripts accepts as an argument the number of seconds to wait between
  123. each test, in order to optimize the CPU time used.
  124.  
  125.  
  126. To start Rock from Spot, use the "StartRock.spot" script from the Arexx
  127. menu in Spot. You can also put "rock:rock" in the "Poll" gadget of the
  128. "settings->system" window.
  129.  
  130. The "CallNode" script allows you to use a reqtools requester to enter
  131. the address of the node you want to call. The "Boss" button calls
  132. directly your boss. Note that this script needs the rexxreqtools.library.
  133.  
  134.  
  135.  
  136. Notes
  137. -----
  138.  
  139. Rock is MailWare. If you like it, please send me a nice postcard of your
  140. country (or if you're too lazy a NetMail will do :-) ). It not only
  141. makes me happy but allows me to register the users for a better support.
  142.  
  143.  
  144. Enjoy !... :-)
  145.  
  146. Comments, suggestions and of course donations are welcome:
  147.  
  148. smail:     Jean-Marc Xiumé
  149.            Parc du Belvédère
  150.            83120 Sainte-Maxime
  151.            FRANCE
  152.  
  153. fidonet :  2:320/104.22
  154. amiganet:  39:180/1.22
  155. usenet  :  jmx@ramses.fdn.org
  156.            jmx@ramses.telesys-innov.fr
  157.  
  158.  
  159.  
  160.  
  161. Thanks to
  162. ---------
  163.  
  164. - All those who created WPL
  165. - Denis Turcotte for the original idea and the first wpl script.
  166. - Robert Williamson for the original XferQ management script
  167.   (see extras/jaz.f for the original script)
  168.  
  169. - Patrice Orio, Arnaud Meurgues, Alain Chofardet, Luc Gibert, and
  170.   Pierre Delisle for beta testing and improvement ideas.
  171.  
  172.  
  173.  
  174. History
  175. -------
  176.  
  177.  
  178. * Rock 1.5 - 30 jul 1995
  179.  
  180.  
  181. * Rock 1.5beta2 - 15 jul 1995
  182.  
  183. - Added the CallNode script (launch rock via a reqtools requester).
  184. - The 680x0 version of the xprzedzap.library v3.5 crashed the system.
  185.   It's replaced by the older 1.5 version, that also runs under system 1.3.
  186. - Corrected the xprzedzap.library initstring (xprsetup).
  187. - Some minor bugfixes.
  188.  
  189.  
  190. * Rock 1.5beta - 23 may 1995
  191.  
  192. - Added version 1.4 changes to rock 1.3a
  193. - Rock now reconises the "NO ANSWER" string used by some modems.
  194. - To improve reading, a blank line is printed in the status window after
  195.   receiving each file.
  196. - Put back the turnaround delay (2 seconds between the sending and the
  197.   receiving phase).
  198.  
  199.  
  200. * Rock 1.4 - 19 apr 1995
  201.   (released by Robert Williamson, modified from rock version 1.3 / 01 mar 1995)
  202.  - corrected invalid copyright notices
  203.  - added missing copyright notices 
  204.  - removed the possibly privatee version of wpl.library v0.99.02 and replaced it
  205.    with the public version 0.97.04
  206.  - replaced obsolete xprzedzap.library 0.56j with the current version 3.5
  207.  - corrected xprsetup command for new xprzedzap.library
  208.  
  209.  
  210. * Rock 1.3a - 29 mar 1995
  211.  
  212. - Small bug fixed in rock.wpl : ROCKDEF!FIDO was called but this
  213.   section doesn't exist in the default config.
  214. - A "return" was missing in rock.cfg at the end of the MODEM section.
  215. - Added support for .FLO files without the full qualified path for
  216.   fido packets. Now the outbound path is checked and added if necessary.
  217.  
  218.  
  219. * Rock 1.3  - 01 mar 1995
  220.  
  221. - "waitrock" support script. Waits until rock exits.
  222.  
  223.  
  224. * Rock 1.3beta5 - 12 feb 1995
  225.  
  226. - ** Warning, configuration file modified ! Read the docs !! **
  227.   . Parameters grouped in 5 sections (nets,fido,modem,display,files).
  228.   . Added the addresses of the boss' different nets (fidonet,
  229.     amiganet...).
  230.   . Added the initloop and initwait parameters, for modem initialization
  231.     purpose.
  232.   . Added the minbaud parameter, to hang up the modem if the connexion
  233.     speed with the boss is lower than minbaud.
  234.   . Changed the names of the display variables.
  235.   . Added the closestatus parameter, to choose if the status window will
  236.     close itself of not, after rock has exited.
  237.   . Added the nodelist parameter. It's the path of the directory where
  238.     are the nodelist files.
  239. - It's now possible to use the NodeList ! (traplist format).
  240. - The configuration parameters have now a default value, except of course
  241.   those in the FIDO section.
  242. - Suppressed the .FLO part in the "rock" script. This is now done by the
  243.   new "bossflo.rexx" script.
  244. - No need to change the "rock" script any more, neither for the boss main
  245.   address, nor for the different nets. All is now done in "rock.cfg".
  246. - Changed the modem init phase.
  247. - Automatic creation of the xferq directory ("assignxferq" script)
  248. - Updated the config-file doc, be sure to read it.
  249. - The validity of the given address is now checked before calling, by the
  250.   new "addrcheck.rexx" script.
  251. - New "nodelist.rexx" script, to find the node's phone number and password
  252.   in the nodelist.
  253. - Corrected a bug in rock.rexx . The .?LO files with a CR as line-end
  254.   caracter are now handled correctly.
  255. - New "config" argument to the "rock" script, in order to use the config
  256.   file of your choice.
  257.  
  258.  
  259. * Rock 1.2c - 30 dec 1994
  260.  
  261. Unrealeased developpement version.
  262.  
  263.  
  264. * Rock 1.2b - 14 dec 1994
  265.  
  266. - Some minor changes.
  267.  
  268.  
  269. * Rock 1.2a - 01 oct 1994
  270.  
  271. - Rock is now able to open its windows on a given public screen.
  272.  
  273.  
  274. * Rock 1.2  - 28 sep 1994
  275.  
  276. - Amigados launch script "rock" changed in order to concatenate the .FLO
  277.   files of the different nets in a single file named with the main address
  278.   of the boss. Previously, rock sent only the fidonet files.
  279. - Added the different addresses of the boss in the config file, in order
  280.   to have the correct address for each called phone number.
  281. - Added "bossoutbound.rexx" script to rename the .?LO, .?UT and .REQ files
  282.   according to the current called boss address. Rock doesn't support AKAs,
  283.   and send only the files that match the current address.
  284. - The logfile reports if the given address doesn't match the one we are
  285.   connected to.
  286. - Rock.wpl updated according to the above changes.
  287.  
  288.  
  289. * Rock 1.1  - 24 sep 1994
  290.  
  291. - The Rock.rexx script has been corrected, as the previous didn't sent
  292.   out the file-attaches (at least in my tests with Trapdoor ;) ).
  293. - Use of the ROCK: assign instead of Mail: for Rock's files.
  294. - The logfile gives more details on what's going on:
  295.   . date and time at the beginning of each line.
  296.   . start and exit point of the program.
  297.   . address ans phone number of the called system.
  298.   . reports the reply message from the modem.
  299.   . tells if an error has occured or if the session has been manually
  300.     aborted.
  301.   . after the negociation, gives the name of the called system, the name
  302.     of the sysop, and the name of his mailer.
  303.   . session connect time (ROCKtime.rexx).
  304. - Various changes in ROCK.wpl.
  305. - KillRock script, just in case ;)
  306.  
  307.  
  308. * Rock 1.0
  309.  
  310. - Used the rock.rexx script from the JAZ 1.01 mailer,
  311.   Copyright (c) 1994 Robert Williamson.
  312.  
  313. * POP 0.9 *
  314.  
  315. Original version Copyright (c) Denis Turcotte 1994.
  316.